home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / zangband.lha / Zangband261 / help / pref.txt < prev    next >
Encoding:
Text File  |  2001-07-01  |  9.3 KB  |  201 lines
  1. === User Pref Files ===
  2.  
  3. Zangband allows you to change various aspects of the game to suit your
  4. tastes. You may define keymaps (changing the way Zangband maps your
  5. keypresses to underlying commands), create macros (allowing you to map
  6. a single keypress to a series of keypresses), modify the visuals
  7. (allowing you to change the appearance of monsters, objects, or terrain
  8. features), change the colors (allowing you to make a given color
  9. brighter, darker, or even completely different), or set options
  10. (turning them off or on).
  11.  
  12. Zangband stores your preferences in files called "user pref files",
  13. which contain comments and "user pref commands", which are simple
  14. strings describing one aspect of the system about which the user has a
  15. preference. There are many ways to load a user pref file, and in fact,
  16. some of these files are automatically loaded for you by the game. All
  17. of the files are kept in the "lib/user/" directory, though you may have
  18. to use one of the command line arguments to redirect this directory,
  19. especially on multiuser systems. You may also enter single user pref
  20. commands directly, using the special "Enter a user pref command"
  21. command, activated by "double quote". You may have to use the "redraw"
  22. command (^R) after changing certain of the aspects of the game, to
  23. allow Zangband to adapt to your changes.
  24.  
  25. When the game starts up, after you have loaded an old character, or
  26. created a new character, some user pref files are loaded automatically.
  27. First, the "pref.prf" file is loaded. This file contains some user
  28. pref commands which will work on all platforms. Then one of
  29. "font-xxx.prf" (for normal usage) or "graf-xxx.prf" (for bitmap usage)
  30. is loaded. These files contain attr/char changes to allow the monsters,
  31. objects, and/or terrain features to look "better" on your system. Then
  32. the "pref-xxx.prf" file is loaded. This file contains pre-defined
  33. system specific stuff (macros, color definitions, etc). Then, the
  34. "user-xxx.prf" file is loaded. This file contains user-defined system
  35. specific stuff. The "user-xxx.prf" file is used as the "default" user
  36. pref file in many places. The "xxx" is the "system suffix" for your
  37. system, taken from the "main-xxx.c" file which was used to generate
  38. your executable. Finally, the "Race.prf", "Class.prf", and "Name.prf"
  39. files are loaded, where "Race", "Class", and "Name" are replaced by the
  40. actual race, class, and name of the current character.
  41.  
  42. Several commands allow you to both load existing user pref files,
  43. create new user pref files, append information to existing user pref
  44. files, and/or interact with various of the user preferences in a more
  45. intuitive way than the user pref commands allow. The commands include
  46. "Interact with macros" (@), "Interact with visuals" (%), and "Interact
  47. with colors" (&), described below.
  48.  
  49.  
  50. ***** <Commands>
  51. --- User pref file commands ---
  52.  
  53. Interact with options (=)
  54.      Allow you to interact with options. Note that using the "cheat"
  55.      options may mark your savefile as unsuitable for the high score
  56.      list. You may change normal options using the "X" and "Y" user
  57.      pref commands. You must use the "redraw" command (^R) after
  58.      changing certain options.
  59.  
  60. Interact with macros (@)
  61.      Allow you to interact with macros. You may load or save macros
  62.      from user pref files, create macros of various types, or define
  63.      keymaps. You must define a "current action", shown at the bottom
  64.      of the screen, before you attempt to use any of the "create macro"
  65.      commands, which use that "current action" as their action. This
  66.      is a horrible interface, and will be fixed eventually.
  67.  
  68. Interact with visuals (%)
  69.      Allow you to interact with visuals. You may load or save visuals
  70.      from user pref files, or modify the attr/char mappings for the
  71.      monsters, objects, and terrain features. You must use the "redraw"
  72.      command (^R) to redraw the map after changing attr/char mappings.
  73.  
  74. Interact with colors (&)
  75.      Allow the user to interact with colors. This command only
  76.      works on some systems.
  77.  
  78. Interact with the system (!)
  79.      Allow the user to interact with the underlying visual system.
  80.      This command is currently unused.
  81.  
  82.  
  83. ***** <Macros>
  84. --- User Pref Files (Macros) ---
  85.  
  86. The "Interact with macros" command allows you to define or remove
  87. "macros", which are mappings from a single logical keypress to a
  88. sequence of keypresses, allowing you to use special keys on the
  89. keyboard, such as function keys or keypad keys, possibly in conjunction
  90. with modifier keys, to "automate" repetitive multi-keypress commands
  91. that you use a lot.
  92.  
  93. Since macros represent keypress sequences, and not all keypresses have
  94. a printable representation, macro triggers and actions must often be
  95. "encoded" into a human readable form. This is done using several types
  96. of encoding, including "\xHH" for character number HH in hexadecimal,
  97. "\e" for the "escape" code, "\n" for the "newline" code, "\r" for the
  98. "return" code, "\s" for the "space" code, "\\" for backslash, "\^" for
  99. caret, and "^X" for the code for any "control" key "ctrl-X". Note that
  100. the "action" of a macro will not be checked against other macro
  101. triggers (unless the macro action contains a "control-backslash"), so
  102. you cannot make infinite loops. You may specify extremely long macros,
  103. but you are limited in length by the underlying input mechanisms,
  104. which in general limit you to about 1024 keys in both triggers and
  105. actions.
  106.  
  107. The special "\" command (which must be encoded in macros as "\\") is
  108. very useful in macros, since it bypasses all keymaps and allows the
  109. next keystroke to be considered a command in the underlying Zangband
  110. command set. For a list of the Zangband command set, see the
  111. "command.txt" help file. For example, a macro which maps Shift-KP6 to
  112. "\" + "." + "6" will induce the "run east" behavior, regardless of what
  113. keyset the user has chosen, and regardless of what keymaps have been
  114. defined.
  115.  
  116. Macros can be specified in user pref files as a pair of lines, one of
  117. the form "A:<str>", which defines the encoded macro action, and one of
  118. the form "P:<str>", which defines the encoded macro trigger.
  119.  
  120.  
  121. ***** <KeyMaps>
  122. --- User Pref Files (Keymaps) ---
  123.  
  124. The "Interact with macros" command also allows you to define "keymaps",
  125. which are vaguely related to macros. A keymap maps a single keypress to
  126. a series of keypresses, which bypass both other keymaps and any macros.
  127. Zangband uses keymaps to map the original and the roguelike keysets to
  128. the underlying command set, and allows the user to modify or add
  129. keymaps of their own. Note that all keymap actions must be specified
  130. using underlying commands, not keypresses from the original or
  131. roguelike keysets. The original keyset is almost identical to the
  132. underlying keyset, except that "numbers" are mapped to ";" plus a
  133. direction, "5" is mapped to ",", and a few control-keys are mapped to
  134. various things. See "command.txt" for the full set of underlying
  135. commands. Some uses for keymaps include the ability to "disable" a
  136. command by mapping it to "\x00".
  137.  
  138. Keymaps can be specified in user pref files as lines of the form
  139. "M:<T> <key> <str>", where <T> is the keyset (0 for original and 1 for
  140. roguelike), <key> is the encoded trigger key, and <str> is the encoded
  141. keymap action.
  142.  
  143.  
  144. ***** <Visuals>
  145. --- User Pref Files (Visuals) ---
  146.  
  147. You can use the "Interact with visuals" command to change various
  148. visual information, currently including the choice of what attr/char
  149. values are used to represent various monsters, objects, or terrain
  150. features. Note that in combination appropriate support in "main-xxx.c",
  151. and with the use of the "use_graphics" flag, you may be able to specify
  152. that "graphic bitmaps" should be used instead of normal "colored
  153. characters" for various things.
  154.  
  155. When interactively modifying the attr/char values for monsters,
  156. objects, or terrain features, pressing "n" or "N" will change which
  157. entry you are changing, pressing "a" or "A" will rotate through the
  158. available attr values, and pressing "c" or "C" will rotate though the
  159. available char values. Note that attr/char values with the "high bit"
  160. set may induce the display of special "graphic" pictures if the
  161. "use_graphics" flag is set, and your system supports the "use_graphics"
  162. flag.
  163.  
  164. Note that this command can be abused in various ways, and if you must
  165. do so, remember that you are only cheating yourself.
  166.  
  167. Keymaps can be specified in user pref files as lines of the form
  168. "R:<N>:<A>/<C>" or "K:<N>:<A>/<C>" or "F:<N>:<A>/<C>" or
  169. "U:<N>:<A>/<C>".
  170.  
  171.  
  172. ***** <Colors>
  173. --- User Pref Files (Colors) ---
  174.  
  175. The "Interact with colors" command allows you to change the actual
  176. internal values used to display various colors. This command may or may
  177. not have any effect on your machine. Advanced machines may allow you to
  178. change the actual RGB values used to represent each of the 16 colors
  179. used by Zangband, and perhaps even allow you to define new colors which
  180. are not currently used by Zangband.
  181.  
  182. Colors can be specified in user pref files as lines of the form
  183. "V:<N>:<V>:<R>:<G>:<B>".
  184.  
  185.  
  186. ***** <Options>
  187. --- User Pref Files (Options) ---
  188.  
  189. The "Interact with options" command allows you to turn options on or
  190. off. You may turn options off or on using the user pref commands of the
  191. form "X:<option>" or "Y:<option>" respectively.
  192.  
  193.  
  194. -- 
  195. Original   : Alexander Cutler and Andy Astrand
  196. Updated    : (2.7.6) by Russ Allbery (rra@cs.stanford.edu)
  197. Updated    : (2.7.9) by Ben Harrison (benh@phial.com)
  198. Updated    : Zangband 2.2.0 through 2.2.6c by Robert Ruehlmann
  199. Updated    : Zangband DevTeam
  200. Last update: January 13, 2000
  201.